Spot-On
spot-on-misc.h
1 /*
2 ** Copyright (c) 2011 - 10^10^10, Alexis Megas.
3 ** All rights reserved.
4 **
5 ** Redistribution and use in source and binary forms, with or without
6 ** modification, are permitted provided that the following conditions
7 ** are met:
8 ** 1. Redistributions of source code must retain the above copyright
9 ** notice, this list of conditions and the following disclaimer.
10 ** 2. Redistributions in binary form must reproduce the above copyright
11 ** notice, this list of conditions and the following disclaimer in the
12 ** documentation and/or other materials provided with the distribution.
13 ** 3. The name of the author may not be used to endorse or promote products
14 ** derived from Spot-On without specific prior written permission.
15 **
16 ** SPOT-ON IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
17 ** IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
18 ** OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
19 ** IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
20 ** INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
21 ** NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
22 ** DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
23 ** THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24 ** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
25 ** SPOT-ON, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26 */
27 
28 #ifndef _spoton_misc_h_
29 #define _spoton_misc_h_
30 
31 #if QT_VERSION >= 0x050501 && defined(SPOTON_BLUETOOTH_ENABLED)
32 #include <QBluetoothAddress>
33 #endif
34 #include <QHostAddress>
35 #include <QPair>
36 #include <QReadWriteLock>
37 #include <QSqlDatabase>
38 #include <QString>
39 #include <QVariant>
40 
41 #if defined(Q_OS_WIN)
42 extern "C"
43 {
44 #include <winsock2.h>
45 #include <ws2tcpip.h>
46 }
47 #else
48 extern "C"
49 {
50 #include <netinet/in.h>
51 #include <sys/socket.h>
52 }
53 #endif
54 
55 /*
56 ** Please read http://gcc.gnu.org/onlinedocs/gcc-4.4.1/gcc/Optimize-Options.html#Type_002dpunning.
57 */
58 
60 {
61  struct sockaddr sockaddr;
62  struct sockaddr_in sockaddr_in;
63  struct sockaddr_in6 sockaddr_in6;
64  struct sockaddr_storage sockaddr_storage;
65 }
67 
68 class spoton_crypt;
69 
71 {
72  public:
73  static QByteArray findPublicKeyHashGivenHash(const QByteArray &randomBytes,
74  const QByteArray &hash,
75  const QByteArray &hashKey,
76  const QByteArray &haskType,
77  spoton_crypt *crypt);
78  static QByteArray forwardSecrecyMagnetFromList
79  (const QList<QByteArray> &list);
80  static QByteArray publicKeyFromHash(const QByteArray &publicKeyHash,
81  spoton_crypt *crypt);
82  static QByteArray publicKeyFromSignaturePublicKeyHash
83  (const QByteArray &signaturePublicKeyHash, spoton_crypt *crypt);
84  static QByteArray signaturePublicKeyFromPublicKeyHash
85  (const QByteArray &publicKeyHash, spoton_crypt *crypt);
86  static QByteArray urlToEncoded(const QUrl &url);
87  static QByteArray xor_arrays(const QByteArray &a, const QByteArray &b);
88  static QHash<QString, QByteArray> retrieveEchoShareInformation
89  (const QString &communityName, spoton_crypt *crypt);
90  static QHostAddress peerAddressAndPort(
91 #if defined(Q_OS_WIN)
92  const SOCKET socketDescriptor,
93 #else
94  const int socketDescriptor,
95 #endif
96  quint16 *port);
97  static QList<QByteArray> findEchoKeys(const QByteArray &bytes1,
98  const QByteArray &bytes2,
99  QString &type,
100  spoton_crypt *crypt);
101  static QList<QByteArray> findForwardSecrecyKeys(const QByteArray &bytes1,
102  const QByteArray &bytes2,
103  QString &messageType,
104  spoton_crypt *crypt);
105  static QList<QHash<QString, QVariant> > poptasticSettings
106  (const QString &in_username, spoton_crypt *crypt, bool *ok);
107  static QPair<QByteArray, QByteArray> decryptedAdaptiveEchoPair
108  (const QPair<QByteArray, QByteArray>, spoton_crypt *crypt);
109  static QPair<QByteArray, QByteArray> findGeminiInCosmos
110  (const QByteArray &data, const QByteArray &hash, spoton_crypt *crypt);
111  static QSqlDatabase database(QString &connectionName);
112  static QString countryCodeFromIPAddress(const QString &ipAddress);
113  static QString countryNameFromIPAddress(const QString &ipAddress);
114  static QString databaseName(void);
115  static QString homePath(void);
116  static QString htmlEncode(const QString &string);
117  static QString keyTypeFromPublicKeyHash(const QByteArray &publicKeyHash,
118  spoton_crypt *crypt);
119  static QString massageIpForUi(const QString &ip, const QString &protocol);
120  static QString nameFromPublicKeyHash(const QByteArray &publicKeyHash,
121  spoton_crypt *crypt);
122  static QString prettyFileSize(const qint64 size);
123  static QString removeSpecialHtmlTags(const QString &text);
124  static bool acceptableTimeSeconds(const QDateTime &then, const int delta);
125  static bool allParticipantsHaveGeminis(void);
126  static bool authenticateAccount(QByteArray &name,
127  QByteArray &password,
128  const qint64 listenerOid,
129  const QByteArray &saltedCredentials,
130  const QByteArray &salt,
131  spoton_crypt *crypt);
132  static bool importUrl(const QByteArray &c, // Content
133  const QByteArray &d, // Description
134  const QByteArray &t, // Title
135  const QByteArray &u, // URL
136  const QSqlDatabase &db,
137  const int maximum_keywords,
138  const bool disable_synchronous_sqlite_writes,
139  QString &error,
140  spoton_crypt *crypt);
141  static bool isAcceptedIP(const QHostAddress &address,
142  const qint64 id,
143  spoton_crypt *crypt);
144  static bool isAcceptedIP(const QString &address,
145  const qint64 id,
146  spoton_crypt *crypt);
147  static bool isAcceptedParticipant(const QByteArray &publicKeyHash,
148  const QString &keyType,
149  spoton_crypt *crypt);
150  static bool isAuthenticatedHint(spoton_crypt *crypt);
151  static bool isIpBlocked(const QHostAddress &address,
152  spoton_crypt *crypt);
153  static bool isIpBlocked(const QString &address,
154  spoton_crypt *crypt);
155  static bool isMulticastAddress(const QHostAddress &address);
156  static bool isPrivateNetwork(const QHostAddress &address);
157  static bool isValidBuzzMagnet(const QByteArray &magnet);
158  static bool isValidBuzzMagnetData(const QByteArray &data);
159  static bool isValidForwardSecrecyMagnet(const QByteArray &magnet,
160  QList<QByteArray> &values);
161  static bool isValidInstitutionMagnet(const QByteArray &magnet);
162  static bool isValidSignature(const QByteArray &data,
163  const QByteArray &publicKeyHash,
164  const QByteArray &signature,
165  spoton_crypt *crypt);
166  static bool isValidSMPMagnet(const QByteArray &magnet,
167  QList<QByteArray> &values);
168  static bool isValidStarBeamMagnet(const QByteArray &magnet);
169  static bool isValidStarBeamMissingLinksMagnet(const QByteArray &magnet);
170  static bool joinMulticastGroup(const QHostAddress &address,
171  const QVariant &loop,
172 #if defined(Q_OS_WIN)
173  const SOCKET socketDescriptor,
174 #else
175  const int socketDescriptor,
176 #endif
177  const quint16 port);
178  static bool prepareUrlDistillersDatabase(void);
179  static bool prepareUrlKeysDatabase(void);
180  static bool saveFriendshipBundle(const QByteArray &keyType,
181  const QByteArray &name,
182  const QByteArray &publicKey,
183  const QByteArray &sPublicKey,
184  const qint64 neighborOid,
185  const QSqlDatabase &db,
186  spoton_crypt *crypt,
187  const bool useKeyTypeForName = true);
188  static bool saveGemini(const QPair<QByteArray, QByteArray> &gemini,
189  const QString &oid,
190  spoton_crypt *crypt);
191  static bool saveReceivedStarBeamHash(const QSqlDatabase &db,
192  const QByteArray &hash,
193  const QString &oid,
194  spoton_crypt *crypt);
195  static bool storeAlmostAnonymousLetter(const QList<QByteArray> &list,
196  spoton_crypt *crypt);
197  static int minimumNeighborLaneWidth(void);
198  static qint64 participantCount(const QString &keyType,
199  spoton_crypt *crypt);
200  static quint64 databaseAccesses(void);
201  static spoton_crypt *cryptFromForwardSecrecyMagnet
202  (const QByteArray &magnet);
203  static spoton_crypt *parsePrivateApplicationMagnet(const QByteArray &magnet);
204  static spoton_crypt *retrieveUrlCommonCredentials(spoton_crypt *crypt);
205  static void alterDatabasesAfterAuthentication(spoton_crypt *crypt);
206  static void cleanupDatabases(spoton_crypt *crypt);
207  static void closeSocket
208 #if QT_VERSION < 0x050000
209  (const int socketDescriptor);
210 #else
211  (const qintptr socketDescriptor);
212 #endif
213  static void correctSettingsContainer(QHash<QString, QVariant> settings);
214  static void enableLog(const bool state);
215  static void logError(const QString &error);
216  static void populateUrlsDatabase(const QList<QList<QVariant> > &list,
217  spoton_crypt *crypt);
218  static void prepareAuthenticationHint(spoton_crypt *crypt);
219  static void prepareDatabases(void);
220  static void prepareSignalHandler(void (*signal_handler) (int));
221  static void purgeSignatureRelationships(const QSqlDatabase &db,
222  spoton_crypt *crypt);
223  static void removeOneTimeStarBeamMagnets(void);
224  static void retrieveSymmetricData(QPair<QByteArray, QByteArray> &gemini,
225  QByteArray &publicKey,
226  QByteArray &symmetricKey,
227  QByteArray &hashKey,
228  QByteArray &startsWith,
229  QString &neighborOid,
230  QString &receiverName,
231  const QByteArray &cipherType,
232  const QString &oid,
233  spoton_crypt *crypt,
234  bool *ok);
235  static void saveParticipantStatus(const QByteArray &name,
236  const QByteArray &publicKeyHash,
237  const QByteArray &status,
238  const QByteArray &timestamp,
239  const int seconds,
240  spoton_crypt *crypt);
241 #if QT_VERSION >= 0x050501 && defined(SPOTON_BLUETOOTH_ENABLED)
242  static void savePublishedNeighbor(const QBluetoothAddress &address,
243  const quint16 port,
244  const QString &statusControl,
245  const QString &orientation,
246  spoton_crypt *crypt);
247 #endif
248  static void savePublishedNeighbor(const QHostAddress &address,
249  const quint16 port,
250  const QString &transport,
251  const QString &statusControl,
252  const QString &orientation,
253  spoton_crypt *crypt);
254  static void setTimeVariables(const QHash<QString, QVariant> &settings);
255  static void vacuumAllDatabases(void);
256  template<typename T>
257  static T readSharedResource(T *resource, QReadWriteLock &mutex)
258  {
259  QReadLocker locker(&mutex);
260  T value = T();
261 
262  if(resource)
263  value = *resource;
264 
265  return value;
266  }
267  template<typename T>
268  static void setSharedResource(T *resource, const T &value,
269  QReadWriteLock &mutex)
270  {
271  QWriteLocker locker(&mutex);
272 
273  if(resource)
274  *resource = value;
275  }
276 
277  private:
278  static QAtomicInt s_enableLog;
279  static QReadWriteLock s_dbMutex;
280  static QReadWriteLock s_logMutex;
281  static quint64 s_dbId;
282  spoton_misc(void);
283  static void logErrorThread(const QString &error);
284 };
285 
286 #endif
Definition: spot-on-misc.h:59
Definition: spot-on-misc.h:70
Definition: spot-on-crypt.h:65